[]
产品官网 帮助文档 API 文档 视频教程 技术社区
在线Demo 免费试用
(Showing Draft Content)

Identity-Role

Identity-Role

[GET] /api/v2/identity/roles

获取所有角色。

参数:

名称 类型 位置 描述 示例
IncludePermissions Boolean query 查询结果中是否包含角色的权限。 true
IncludeMembers Boolean query 查询结果中是否包含角色成员。
SearchType SearchType query 搜索类型，可用值为“none”和“count”。 "Count"

返回值

状态码: 200

成功

RoleBizModel

[POST] /api/v2/identity/roles

添加新角色。

返回值

状态码: 201

已创建

RoleBizModel

状态码: 400

错误的请求

ApiErrorResult

[GET] /api/v2/identity/roles/non-org-roles

获取不属于任何组织的所有角色。

参数:

名称 类型 位置 描述 示例
IncludePermissions Boolean query 查询结果中是否包含角色的权限。 true
IncludeMembers Boolean query 查询结果中是否包含角色成员。
SearchType SearchType query 搜索类型，可用值为“none”和“count”。 "Count"

返回值

状态码: 200

成功

RoleBizModel

[GET] /api/v2/identity/roles/me/non-org-roles

获取当前登录用户的所有全局角色。

参数:

名称 类型 位置 描述
all Boolean query 是否检索所有全局角色，仅当当前登录用户为系统管理员时生效。例如：false

返回值

状态码: 200

成功

RoleBizModel

[GET] /api/v2/identity/roles/{id}

通过id获取角色信息。

参数:

名称 类型 位置 描述
id必填项 string path 角色 ID。
includePermission Boolean query 是否获取指定角色的权限。例如：true

返回值

状态码: 200

成功

RoleBizModel

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/roles/{id}

更新角色。

参数:

名称 类型 位置 描述
id必填项 string path 角色 ID

请求数据格式

RoleUpdateModel

返回值

状态码: 200

成功

RoleBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/roles/{id}

删除角色。

参数:

名称 类型 位置 描述
id必填项 string path 角色 ID。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/roles/{id}/users

获取属于指定角色的所有用户。

参数:

名称 类型 位置 描述
id必填项 string path 角色 ID。

返回值

状态码: 200

成功

UserBizModel

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/roles/{id}/users

将用户添加到指定的角色。

参数:

名称 类型 位置 描述
id必填项 string path 角色 ID。

请求数据格式

RoleUsersUpdateModel

返回值

状态码: 200

成功

UserBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[PUT] /api/v2/identity/roles/{id}/users

更新属于指定角色的用户。

参数:

名称 类型 位置 描述
id必填项 string path 角色 ID。

请求数据格式

RoleUsersUpdateModel

返回值

状态码: 200

成功

UserBizModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[DELETE] /api/v2/identity/roles/{id}/users/{userId}

移除属于指定角色的指定用户。

参数:

名称 类型 位置 描述
id必填项 string path 角色 ID。
userId必填项 string path 用户 ID。

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[GET] /api/v2/identity/roles/{id}/permissions

获取指定角色的权限。

参数:

名称 类型 位置 描述
id必填项 string path 角色 ID。

返回值

状态码: 200

成功

PermissionModel

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/roles/{id}/permissions

更新指定角色的权限。

参数:

名称 类型 位置 描述
id必填项 string path 角色 ID。

请求数据格式

RolePermissionsUpdateModel

返回值

状态码: 200

成功

PermissionModel

状态码: 400

错误的请求

ApiErrorResult

状态码: 404

未找到

ApiErrorResult

[POST] /api/v2/identity/roles/import

导入角色。

请求数据格式

RolesImportModel

返回值

状态码: 200

成功

RoleBizModel

状态码: 400

错误的请求

ApiErrorResult

类型定义

Ƭ SearchType

Enum:

  • None
  • Count

用于搜索记录的搜索类型。

* none - 0 - 正常搜索。
* count - 1 - 仅检索记录计数。

Ƭ RoleBizModel

名称 类型 描述 示例
id可为空 string 角色的独特身份。 "972B2A4C-8C61-4E3B-AD3D-6E889FE8D761"
name可为空 string 角色的显示名称。 "DataManager"
creatorId可为空 string 角色的创建者 ID。 "CF61388C-D7CD-4A61-8FB3-A8A0B6915F3E"
createTime ISO DateTime Sting 角色的创建时间。 "2000-01-01T00:00:00.0000000+08:00"
isBuiltin Boolean 是否是内置角色。
allowEditPermissions Boolean 是否允许编辑角色的权限。 true
permissions可为空 Array<string> 角色的权限。 ["view-report","view-dashboard"]
members可为空 Array<string> 角色的成员id列表。 ["CD079B35-4A56-4F42-845D-726B09E08EA9","EAAA677A-7B0A-4471-99F0-4C3F1D31738C"]
tenantId可为空 string 角色所属组织的 ID。 "D6FD678D-45B5-4222-BA81-58BE2E578F91"
modifiedBy可为空 string 角色的修改者ID。 "CF61388C-D7CD-4A61-8FB3-A8A0B6915F3E"
modifiedTime ISO DateTime Sting 角色的修改时间。 "2000-01-01T00:00:00.0000000+08:00"

Ƭ ApiErrorResult

该模型用于描述处理 Web 请求时发生的所有错误。

名称 类型 描述 示例
errors可为空 ApiError 错误列表。

Ƭ ApiError

该模型用于描述处理 Web 请求时发生的错误。

名称 类型 描述 示例
code可为空 string 错误的唯一标识。
message可为空 string 错误的描述文本。
context可为空 string 错误的一些相关上下文信息。

Ƭ RoleUpdateModel

名称 类型 描述 示例
name可为空 string

Ƭ UserBizModel

名称 类型 描述 示例
id可为空 string
username可为空 string
email可为空 string
mobile可为空 string
provider可为空 string
avatar可为空 string
firstName可为空 string
lastName可为空 string
creationTime ISO DateTime Sting
status UserStatus
fullName可为空 string
organizationIdPath可为空 string
lastLoginTime可为空 ISO DateTime Sting
passwordChangeTime可为空 ISO DateTime Sting
passwordExpirationPolicy UserPasswordExpirationPolicy
roles可为空 Array<string>
customizeProperties可为空 Array<string>
extraClaims可为空 string
tenantRoles可为空 Array<string>

Ƭ UserStatus

Enum:

  • Normal
  • Disabled

用户的状态。

* normal - 1 - 正常状态。
* disabled - 2 - 禁用状态。

Ƭ UserPasswordExpirationPolicy

Enum:

  • FollowSystem
  • NeverExpire

Ƭ RoleUsersUpdateModel

名称 类型 描述 示例
userIds Array<string> 用户 ID 列表。 ["F00FC3E6-8554-467D-9A7E-4598E623BB2F","8259E551-5AFB-489E-8593-0FD6384E123B"]

Ƭ PermissionModel

名称 类型 描述 示例
name可为空 string
description可为空 string
enabled Boolean
order int32
module可为空 string
category可为空 string
isCustomPermission Boolean

Ƭ RolePermissionsUpdateModel

名称 类型 描述 示例
permissions Array<string> 权限列表。 ["view-dashboard","view-report"]

Ƭ RolesImportModel

名称 类型 描述 示例
roles RoleBizModel 角色列表。